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>'
{
  "meta": {
    "tracingId": "27b47dca-fb0f-4448-b470-1cd2d5516d0f"
  },
  "data": {
    "id": "76ad88c7-6e99-4a16-a277-e428a73d1e86",
    "consentId": "5daeb980-5ff5-49db-b7a0-e93dd9c93533",
    "statusDetails": {
      "status": "COMPLETED",
      "updatedAt": "2024-07-25T18:14:52.672Z"
    },
    "createdAt": "2024-07-25T18:14:52.672Z"
  }
}

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