Assign a bulk card

POST 
/customers/:customerId/prepaid/cards/:cardId/assignments

The endpoint can be used to assign a specific card to a given customer. It is applicable only for cards created through the Bulk Card Ordering endpoint. Once assigned, a card cannot be re-assigned.

Request

Path Parameters

customerId stringrequired

The customer ID to which the specific card belongs.

cardId stringrequired

UUID based Card id.

application/json

Body

In order to assign an already existing card created through the Bulk Card Ordering endpoint, only a targetCustomerId needs to be provided in the request body.

targetCustomerId - the customer ID to which the card will be assigned.

targetCustomerId stringrequired

The customer ID to which a specific card will be assigned.

Responses

200

OK

application/json

Schema

Schema

targetCustomerId stringrequired

The customer ID to which a specific card will be assigned.

cardId uuidrequired

Card id is a unique identifier for a specific card. It will be used for most operations to the prepaid card.

customerId stringrequired

The customer ID to which the specific card belongs.

Example (from schema)

{
  "targetCustomerId": "1233333323",
  "cardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerId": "1231122232"
}

SUCCESSFULLY_ASSIGNED_CARD

{
  "cardId": "f16ba382-eb42-481a-b08f-c57bdc9aae24",
  "customerId": "1231122232",
  "targetCustomerId": "1233333323"
}

400

Bad Request

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

ALREADY_ASSIGNED_CARD

{
  "error": {
    "code": "DW-PREPAID-CARDS-ALREADY-ASSIGNED-CARD",
    "message": "The provided cardId is already assigned.",
    "details": [
      "The provided cardId is already assigned to a customer."
    ]
  }
}

ASSIGN_TO_CUSTOMER_NOT_FOUND

{
  "error": {
    "code": "DW-NO-SUCH-CUSTOMER",
    "message": "Customer was not found.",
    "details": [
      "The provided targetCustomerId was not found in the system."
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INVALID_CREDENTIALS

{
  "error": {
    "code": "5279",
    "message": "Invalid credentials",
    "details": [
      "The authentication credentials are invalid."
    ]
  }
}

404

Not Found

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

NO_SUCH_CUSTOMER

{
  "error": {
    "code": "DW-NO-SUCH-CUSTOMER",
    "message": "Customer was not found",
    "details": [
      "No customer matching the provided customerId was found."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_SERVER_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error",
    "details": [
      "There was an error while processing the operation"
    ]
  }
}

503

Service Unavailable

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

SERVICE_UNAVAILABLE

{
  "error": {
    "code": "DW-SERVICE-UNAVAILABLE",
    "message": "Service Unavailable",
    "details": [
      "Service Unavailable"
    ]
  }
}

Loading...