Reverse Payment

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

Reverses a payment by referenceID and returns either the reversed payment or the created refund (for ACH payments for a previous date).

Responses

Response body

object

resultType

string

Defaults to UNKNOWN_REVERSE_PAYMENT_RESULT_TYPE

Identifies the result type of a payment reversal.

UNKNOWN_REVERSE_PAYMENT_RESULT_TYPE PAYMENT REFUND

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.

refund

object

An object that represents a refund model.

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.

requestedAmount

object

Represents a monetary amount in the specified currency

sourceType

string

Defaults to UNKNOWN_SOURCE_TYPE

Identifies how the refund was originated.

UNKNOWN_SOURCE_TYPE OCC REVERSAL

status

string

Defaults to UNKNOWN_STATUS

Identifies the processing status of a refund.

UNKNOWN_STATUS RECEIVED SUCCESS PENDING PARTIAL FAILED NETWORK_FAILED CANCELLED REJECTED RETURNED

createdAt

date-time

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

updatedAt

date-time

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

payments

array of objects

payments

object

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.

paperCheckDetails

object

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api-preview.platform.breadpayments.com/api/payments/payment/reverse \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "scopeType": "UNKNOWN_SCOPE_TYPE"
8
}
9
'

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

application/json

text/plain

200A successful response returns either a reversed payment model or a new refund model.

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized