Skip to content
Gowd Platform Sandbox Sandbox

Get subscription by ID - V1

GET
/order/v1/banking/subscriptions/{id}
 
  Retrieve a subscription by its ID.

NOTE: Please, to authenticate use the scope: “api://app-order-hml”

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

The subscription ID (UUID)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
id
required

The subscription ID

string
Example
b30fa8dc-428c-4bd3-bd1f-5340159a3f9b
providerId
required

The provider ID of the subscription

string
Example
RR33630661202512093d0403bc2a6
type
required

The type of the QR code that was generated

string
Allowed values: AUTHORIZATION_QRCODE AUTHORIZATION_QRCODE_IMMEDIATE_PAYMENT
Example
AUTHORIZATION_QRCODE
status
required

The status of the subscription

string
Allowed values: INITIAL PENDING_AUTHORIZATION ACCEPTED REJECTED CANCELED ERROR
Example
ACCEPTED
statusHistory
required

The status history of the subscription

Array<object>
object
status
required

The status of the subscription when the status history was created

string
Allowed values: INITIAL PENDING_AUTHORIZATION ACCEPTED REJECTED CANCELED ERROR
Example
ACCEPTED
createdAt
required

The date and time when the status history was created, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-01T10:00:00Z
qrcodeDetail
required

The QR code details of the subscription

object
imageBase64
required

The QR code image encoded in base64

string
Example
iVBORw0KGgoAAAANSUhEUgAA...
qrcodeData
required

The QR code payload data

string
Example
00020126580014BR.GOV.BCB.PIX0136d2901f4e-4f6e-4e2d-8c8a-5f3c3f00000052040000530398654041.005802BR5925Nome do Recebedor6009Sao Paulo61080540900062070503***6304B14F
initialCharge

Initial charge details. Available only for journeys that support an initial charge.

object
orderId

Identifier of the order that settles the immediate payment. Use it to follow the charge through the order endpoints and to match the order webhook. Absent only when the subscription failed before the order was created.

string
Example
9c8f1b40-2f2e-4d3a-9b1f-7c1e2a4d5f60
expireDateTime
required

Expiration datetime (ISO)

string
Example
2024-01-01T12:00:00Z
conciliationId
required

Conciliation identifier of the immediate payment.

string
Example
A298FE4B49A1408685311891FC557584
amount
required

Amount of the initial charge

object
currency
required

The currency field.

string
Example
BRL
value
required

The value field.

string
Example
10.95
Example
{
  "currency": "BRL",
  "value": "10.00"
}
allowChargeAfterDueDate

Whether charges are allowed after the due date

boolean
Example
true
allowAdjustToBusinessDay

Whether the due date should be automatically adjusted to the next business day when it falls on a non-business day

boolean
Example
true
frequencyType
required

The frequency of the charges

string
Allowed values: WEEKLY MONTHLY QUARTERLY SEMIANNUAL ANNUAL
Example
MONTHLY
startDate
required

The start date of the recurrence payment in ISO 8601 format (YYYY-MM-DD)

string
Example
2025-01-01
endDate

The end date of the recurrence payment in ISO 8601 format (YYYY-MM-DD)

string
Example
2025-12-31
fixedAmount

Fixed amount to be charged on each cycle

object
currency
required

The currency field.

string
Example
BRL
value
required

The value field.

string
Example
10.95
maxAmountFloor

Minimum value the payer may configure as the authorization maximum amount

object
currency
required

The currency field.

string
Example
BRL
value
required

The value field.

string
Example
10.95
debtor
required

The debtor information object

object
document
required

The debtor document

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678910
Example
{
  "type": "CPF",
  "number": "12345678901"
}
name
required

The debtor name

string
Example
John Doe
receiver
required

The receiver information object

object
id
required

The receiver account ID

string
Example
012a8548-0b0d-4451-97a3-2f86b6a091ae
fullName
required

The full name of the receiver

string
Example
John Doe Organization
document
required

The receiver document

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678910
Example
{
  "type": "CNPJ",
  "number": "33023355667842"
}
payer

The payer information object (available after subscription is accepted)

object
name

The payer name

string
Example
John Doe
document
required

The payer document

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678910
Example
{
  "type": "CPF",
  "number": "12345678901"
}
bankData

The payer bank data

object
ispb
required

The payer bank ISPB

string
Example
12345678
accountNumber
required

The payer bank account number

string
Example
00012345
branchNumber

The payer bank branch number

string
Example
0001
description

The description of the subscription

string
Example
Monthly subscription for premium service
webhookUrl
required

The URL that will receive updates about the status of the subscription

string
Example
https://partner.example.com/webhooks/subscription
externalId
required

The unique code on the partner system

string
Example
partner-id
createdAt
required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-01T10:00:00Z
updatedAt

The date and time when the resource was last updated, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-15T14:30:00Z
cancellations

List of cancellation requests for this subscription

Array<object>
object
id
required

The unique identifier of the cancellation

string
Example
25675d51-8859-4a32-8905-74f48c1148ce
idempotencyKey
required

The idempotency key for the cancellation

string
Example
3ca1e983-57a7-4f9b-9cfb-c568df8d722f
status
required

The current status of the cancellation

string
Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR
Example
ACCEPTED
statusHistory
required

The history of status changes for this cancellation

Array<object>
object
status
required

The status of the cancellation at this point in history

string
Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR
Example
ACCEPTED
createdAt
required

The date and time when this status was recorded, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-01T10:00:00Z
reason
required

The reason for the cancellation

string
Allowed values: ACCOUNT_CANCELLATION PAYER_DECEASED REQUESTED_BY_PAYER REQUESTED_BY_RECEIVER FRAUD_SUSPICION
Example
REQUESTED_BY_PAYER
customer
required

Customer who initiated the cancellation request

object
document
required

Customer document information

object
type
required

Document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

Document number

string
Example
12345678910
createdAt
required

The date and time when the cancellation was created, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-01T10:00:00Z
updatedAt
required

The date and time when the cancellation was last updated, in ISO 8601 format (RFC 3339), UTC

string
Example
2025-01-01T10:05:00Z

400

Section titled “400 ”
object
error
string
Example
INVALID_REQUEST
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Section titled “401 ”

Unauthorized Request

object
error
string
Example
UNAUTHORIZED
message
string
Example
Unauthorized Request
details
Array<object>
object
field
string
issue
string
description
string
Example
[]

403

Section titled “403 ”
object
error
string
Example
FORBIDDEN_ERROR
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]

404

Section titled “404 ”

Resource not found

object
error
string
Example
NOT_FOUND
message
string
Example
Resource not found
details
Array<object>
object
field
string
issue
string
description
string
Example
[]

500

Section titled “500 ”
object
error
string
Example
INTERNAL_ERROR
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]