Get an order

time	status	user agent
Retrieving recent requests…

time

status

user agent

Retrieving recent requests…

200

Successful operation.

Response body

object

string

required

CrediPay's internal order ID.

externalId

string

required

Internal order ID of the seller.

subtotalAmountCents

number

required

The value of the order's goods and or services in cents.

taxAmountCents

number

required

Tax amount in cents.

shippingCostCents

number

required

Shipping costs in cents.

buyerFeesCents

number

required

This field will automatically be calculated. It will have a non-zero value when the seller is configured to charge fees to buyers. Note that this value is already included in the total amount cents.

totalAmountCents

number

required

Total amount in cents. This amount includes buyer fees if applicable. The value of the to-be-created invoice should equal this amount.

shippingLocation

object

Shipping location.

address1

string

required

Defaults to Rua da Consolação, 930

Street address 1.

address2

string

Defaults to Apto 101

Street address 2.

city

string

required

Defaults to São Paulo

City.

region

string

required

Defaults to São Paulo

Region.

postalCode

string

required

Defaults to 01302000

Postal code.

country

string

required

Defaults to Brazil

Country.

paymentTermDays

string

required

Payment term in days. The maturity date of the to-be-created invoice should equal the payment term days added to the order creation date.

status

string

required

Order status.

new created accepted cancelled rejected finalized captured expired ineligible invalidated validating declined

estimatedDeliveryDate

object

required

Estimated delivery UTC date in ISO 8601 format.

Has additional fields

createdAt

string

required

Creation UTC date in ISO 8601 format.

sellerTaxId

string

required

Seller company tax ID.

buyerTaxId

string

required

Buyer company tax ID.

noAdvancing

boolean

required

No advancing

installments

array of objects

required

Installments for the order.

installments*

object

maturityDate

string

required

Defaults to 2024-02-10T00:00:00Z

Installments Maturity Date.

faceValueCents

number

required

Defaults to 1020000

Face value of the installment

xxxxxxxxxx
}
{
  "id": "46dd63dd-1be4-4658-8deb-fa5dc578ad0b",
  "externalId": "REF-10230456",
  "subtotalAmountCents": 1020000,
  "taxAmountCents": 81600,
  "shippingCostCents": 5000,
  "buyerFeesCents": 10978,
  "totalAmountCents": 1117578,
  "shippingLocation": {
    "address1": "Rua da Consolação, 930",
    "address2": "Apto 101",
    "city": "São Paulo",
    "region": "São Paulo",
    "postalCode": "01302000",
    "country": "Brazil"
  },
  "paymentTermDays": 30,
  "status": "finalized",
  "estimatedDeliveryDate": "2024-02-05T00:00:00Z",
  "createdAt": "2024-02-01T00:00:00Z",
  "sellerTaxId": "15853054000096",
  "buyerTaxId": "18360341000052",
  "noAdvancing": false,
  "installments": [
    {

200Successful operation.