Skip to main content
Create Order with Member
curl --request POST \
  --url https://api-demo.bridgepo.com/organization/Sponsor/Order/CreateOrderWithMember \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productCode": "PROD-001",
  "programCode": "PROG-2024-FOOD",
  "email": "member@example.com",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneCountryCode": "1",
  "phone": "5551234567",
  "optInNotification": true,
  "optInForSMSOrEmail": true,
  "externalId": "EXT-MBR-12345",
  "externalTransactionId": "TXN-2024-00001",
  "processingDate": "2026-04-15T00:00:00Z"
}
'
{
  "success": true,
  "statusText": "Ok",
  "statusCode": null,
  "id": 12345,
  "dependantId": null
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the /identity/Auth/SignIn endpoint.

Body

application/json
​
productCode
string
required

Product code provided by the iQpay team for the specific benefit card type. If there are multiple products, send a comma-separated list of product codes.

Example:

"PROD-001"

​
programCode
string
required

Program code provided by the iQpay team identifying the sponsor's program.

Example:

"PROG-2024-FOOD"

​
email
string<email>
required

Member's email address. Used for card delivery if program is configured for email.

Maximum string length: 80
Example:

"member@example.com"

​
firstName
string
required

Member's first name.

Maximum string length: 50
Example:

"Jane"

​
lastName
string
required

Member's last name.

Maximum string length: 50
Example:

"Smith"

​
phoneCountryCode
string
default:1
required

Phone country code. Defaults to 1 (US) if not provided.

Maximum string length: 1
Example:

"1"

​
phone
string
required

Member's mobile phone number. Used for SMS card delivery.

Maximum string length: 10
Example:

"5551234567"

​
optInNotification
boolean
required

Indicates whether the member has provided consent to receive future communications from the organization. Set to true when prior messaging consent has not been established, such as when collecting member information for the first time.

Example:

true

​
optInForSMSOrEmail
boolean
required

Member opt-in to receive SMS/email for digital card delivery. Must be set to true for all members.

Example:

true

​
externalId
string

Sponsor's external identifier for the member (e.g., employee code). Optional, but required if enabled in Program configuration.

Maximum string length: 50
Example:

"EXT-MBR-12345"

​
externalTransactionId
string

Sponsor's external transaction identifier for tracing. Optional, but required when the program is configured to send communication through webhook.

Maximum string length: 50
Example:

"TXN-2024-00001"

​
processingDate
string<date-time> | null

Optional scheduled processing date for the order. If not provided, the order is processed immediately. Used to schedule future card delivery.

Example:

"2026-04-15T00:00:00Z"

Response

Order created successfully.

​
success
boolean

Whether the order was created successfully.

Example:

true

​
statusText
string

Status message from the server.

Example:

"Ok"

​
statusCode
integer | null

Status code, if applicable.

Example:

null

​
id
integer

The created order ID.

Example:

12345

​
dependantId
integer | null

Dependant order ID, if applicable.

Example:

null