Search for Single Payments

get https://api-sandbox.thisisbud.com/v1/payments/single

Retrieve and view the status of multiple payments

Responses

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

data

array of objects

required

Array of Single Payment Status Objects

data*

object

payment_id

string

required

Payment Identifier

organisation_id

string

required

Bud's Organisation Identifier

client_id

string

required

Bud's Client/App Identifier

method

string

required

The payment method

BACS FPS SEPA

reference

string

required

length ≤ 18

Reference to use for this payment

recipient

object

required

Details of the recipient of the payment

amount

object

required

The monetary amount.

sender

object

required

Details of the payment sender

known_charges

object

required

A list detailing information surrounding any known charges that may be associated with the payment

state

object

required

Details of the payment state and history

supplementary_status

object

required

A list of supplementary states associated with the payment as described by the specific provider

errors

array of objects

required

A list of any errors that may be associated with the payment

Payment Errors*

object

code

string

required

Error Code

description

string

required

Text string used to give a description of the payment error

created_at

string

required

The created at timestamp for the payment

required_action

string | null

required

This field will indicate that there is an action required to be taken by the client in order to complete the payment.

Value	Description
confirm_single_payment	If present, this value indicates that client has yet to confirm the single payment once the customer has successfully authorised the payment with the provider. This confirmation can be accomplished using the Confirm Single Payment API Endpoint. Please note this step will only be relevant for clients using Bud as a Technical Service Provider (TSP)

confirm_single_payment

metadata

object

required

Metadata for the response including pagination details

total_results

integer

required

The total number of payment results for the request

results

integer

required

The number of payment results currently displayed on the page

page

integer

required

The current page number

total_pages

integer

required

The total number of pages for the request

401

Unauthorised request

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.thisisbud.com/v1/payments/single \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Successful request

404Resource not found