v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

batch-group

Retrieve a payment initiation

Get payment initiation info by ID. In addition to webhooks, this endpoint can be used for polling the status of a payment initiation.

get/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}

Path parameters

profileIdinteger required

Example:12345678

The ID of the profile that the batch group is associated with.

batchGroupIdstring uuid required

Example:54a6bc09-cef9-49a8-9041-f1f0c654cd88

The batch group ID.

paymentInitiationIdinteger required

Example:12345

The payment initiation ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Payment initiation retrieved successfully.

idinteger

Payment initiation ID.

batchGroupIdstring uuid

Batch group ID.

referencestring

Payment reference that will be passed to the network. Can be used for reconciliation.

userIdinteger

The ID of the user who initiated this payment.

profileIdinteger

The ID of the profile this payment belongs to.

type'DIRECT_DEBIT'

Payment type.

status'NEW' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CHARGED_BACK'

Payment initiation status:

NEW — Payment initiation created
PROCESSING — Payment is being processed
COMPLETED — Payment completed successfully
FAILED — Payment failed
CHARGED_BACK — Payment was charged back

accountIdinteger

External account ID associated with the payment.

transferIdinteger nullable

Transfer ID of the direct debit payment. Present only after the direct debit is initiated.

createdTimestring date-time

Date and time when the payment initiation was created.

Example response

{
  "id": 12345,
  "batchGroupId": "068e186d-9632-4937-b753-af3e53f4d0b0",
  "reference": "B1234567",
  "userId": 33333333,
  "profileId": 44444444,
  "type": "DIRECT_DEBIT",
  "status": "NEW",
  "accountId": 1,
  "createdTime": "2022-01-01T19:51:41.423404Z"
}