Skip to main content
Get Bulk Payment File Status
curl --request GET \
  --url https://api.yapily.com/bulk-payments/{bulkPaymentId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'
import requests

url = "https://api.yapily.com/bulk-payments/{bulkPaymentId}"

headers = {
"consent": "<consent>",
"Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {consent: '<consent>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://api.yapily.com/bulk-payments/{bulkPaymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yapily.com/bulk-payments/{bulkPaymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"consent: <consent>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.yapily.com/bulk-payments/{bulkPaymentId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("consent", "<consent>")
req.Header.Add("Authorization", "Basic <encoded-value>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.yapily.com/bulk-payments/{bulkPaymentId}")
.header("consent", "<consent>")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.yapily.com/bulk-payments/{bulkPaymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["consent"] = '<consent>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "meta": {
    "tracingId": "27b47dca-fb0f-4448-b470-1cd2d5516d0f"
  },
  "data": {
    "id": "76ad88c7-6e99-4a16-a277-e428a73d1e86",
    "consentId": "5daeb980-5ff5-49db-b7a0-e93dd9c93533",
    "statusDetails": {
      "status": "COMPLETED",
      "multiAuthorisationStatus": {
        "status": "COMPLETED"
      },
      "updatedAt": "2024-07-25T18:14:52.672Z"
    },
    "createdAt": "2024-07-25T18:14:52.672Z"
  }
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": 10600,
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 401,
"status": "UNAUTHORIZED",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "CREDENTIALS",
"code": 10700,
"message": "Authorization header invalid or credentials not authenticated"
}
]
}
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 404,
"status": "NOT FOUND",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INVALID_REQUEST",
"code": 10800,
"message": "Resource not found"
}
]
}
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 500,
"status": "INTERNAL SERVER ERROR",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INTERNAL_SERVER_ERROR",
"code": 11000,
"message": "Unexpected server error"
}
]
}
}

Authorizations

Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

Mandatory. The consent token containing the user's authorisation to make the request.

Path Parameters

bulkPaymentId
string
required

Mandatory. Bulk payment id returned when bulk payment request was submitted.

Response

OK

meta
object
data
object