Extend Expiration

post https://api-preview.platform.breadpayments.com/api/transaction/{transactionID}/extend-expiration

Extend the current expiration period by 14 days for a valid transaction. This can only be done once and is not enabled be default.

Responses

Response body

object

adjustedAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

applicationID

uuid

required

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

billingContact

object

required

Represents contact information for an entity

name

object

required

Represents the full name

phone

string

Telephone number including country code

address

object

Represents a fully defined address for an entity

string

Email address

buyerID

uuid

required

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

createdAt

date-time

required

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

description

string

required

a description for the transaction

discountAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

expirationExtended

boolean

required

Whether the expiration has been extended for this transaction

expiresAt

date-time

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

externalID

string

required

An identifier that has significance to the Merchant allowing the transaction to be associated with the Merchant’s systems.

fulfillmentCarrier

string

the shipping carrier moving the transacted item.

fulfillmentTrackingNumber

string

the number used to see the shipping progress of the transacted item.

uuid

required

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

locationID

uuid

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

merchantID

uuid

required

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

metadata

object

required

Metadata is a JSON field available to merchants for storing external data on a Transaction
Metadata keys have a max size of 128, and there can be up to 50 keys total. The max value size for a key is 5000.

Has additional fields

paymentAgreementID

uuid

required

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

paymentProductID

uuid

required

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

merchantPaymentProductValuesID

uuid

required

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

productType

string

required

The type of payment product

INSTALLMENTS SPLITPAY DEBT_CONSOLIDATION PERSONAL_LOAN

programID

uuid

required

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

merchantProgramValuesID

uuid

required

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

refundedAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

chargedbackAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

cancelledAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

settledAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

overflowAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

shippingAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

shippingContact

object

required

Represents contact information for an entity

name

object

required

Represents the full name

phone

string

Telephone number including country code

address

object

Represents a fully defined address for an entity

string

Email address

status

string

required

The possible statuses of a Transaction

AUTHORIZED CANCELLED EXPIRED PARTIALLY_AUTHORIZED PARTIALLY_REFUNDED PARTIALLY_SETTLED PENDING REFUNDED SETTLED CHARGEDBACK PARTIALLY_CHARGEDBACK

taxAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

tenantID

uuid

required

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

isCarts

boolean

required

Whether the transacted item is associated with a cart id.

totalAmount

object

required

Represents a monetary amount in the specified currency

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

revision

integer

required

The revision of the transaction. Incremented whenever there is a change to the transaction.

updatedAt

date-time

required

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

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-preview.platform.breadpayments.com/api/transaction/transactionID/extend-expiration \
3
     --header 'accept: application/json'

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

application/json

text/plain

200Data for a single transaction.

400The request was invalid.

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

404The requested resource was not found

500The requested resource conflicts with an existing resource.

503The service is unavailable.