Receive a payment

put https://api-preview.platform.breadpayments.com/api/payments/payment/receive

Receive a payment, If the payment is already in received status, it will be ignored. If payment in PENDING status, the status will be update to received and send kafka event.

Responses

Response body

object

payment

object

An object that represents a payment model.

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

ownerEntityID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

paymentMethodID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

programID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

referenceID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

sourceID

string

Source identifier.

paymentProductID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

amount

object

Represents a monetary amount in the specified currency

ownerEntityType

string

Defaults to UNKNOWN_ENTITY_TYPE

Identifies information about the caller making the payment.

UNKNOWN_ENTITY_TYPE PAYMENT_AGREEMENT SETTLEMENT_TRANSACTION

scopeID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

scopeType

string

Defaults to UNKNOWN_SCOPE_TYPE

Identifies the owner of the payment method.

UNKNOWN_SCOPE_TYPE BUYER MERCHANT PROGRAM_AGREEMENT PARTNER

sourceType

string

Defaults to UNKNOWN_SOURCE_TYPE

Identifies how the payment was originated.

UNKNOWN_SOURCE_TYPE AUTOPAY SCHEDULED COLLECTIONS ONETIME OCC REFUND DOWN_PAYMENT CHECK_PAYMENT MANUAL_PAYMENT EXTERNAL_COLLECTION SPLITPAY_FIRST_PAYMENT TRADE_IN_CREDIT

subSourceType

string

Defaults to UNKNOWN_SUB_SOURCE_TYPE

Identifies additional source type information.

UNKNOWN_SUB_SOURCE_TYPE WEB TEL IVR

status

string

Defaults to UNKNOWN_STATUS

Identifies the processing status of a payment. Note: FAILED is deprecated in favor of RETURNED

UNKNOWN_STATUS PENDING RECEIVED FAILED RETURNED REJECTED CANCELLED

subStatus

string

Defaults to UNKNOWN_SUB_STATUS

Identifies additional payment status information.

UNKNOWN_SUB_STATUS NONE RETRY

transactionType

string

Defaults to UNKNOWN_TRANSACTION_TYPE

Identifies whether the payment was a credit or a debit.

UNKNOWN_TRANSACTION_TYPE DEBIT CREDIT

deletedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

isCancellable

boolean

A flag indicating if a payment is cancellable

transactionID

string

third party transaction id

reconID

string

third party reconciliation id

createdAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api-preview.platform.breadpayments.com/api/payments/payment/receive \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200A successful response returns a received payment model.

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized